RF Power Detector Device Driver API Reference Manual Overview  Alpha version
Functions
Function List Namespace Reference

Functions

def setShieldType (shield_type)
 This function set the type of shield. More...
 
def connect
 This function open the connection to the shield. More...
 
def readPower
 This function Read RF Power to the shield. More...
 
def readVoltage ()
 This function Read Voltages to the shield. More...
 
def readADCCode ()
 This function Read ADC Codes to the shield. More...
 

Function Documentation

◆ connect()

def Function List.connect (   Port)

This function open the connection to the shield.

Parameters
Port(String) The port number where the Microcontroller is connected.
Returns
None
Note
Shield type must be set first before calling this function.

◆ readADCCode()

def Function List.readADCCode (   ADC_code)

This function Read ADC Codes to the shield.

Parameters
None
Returns
[Integer Array] ADC Code reading depending on what type of shield.
Note
Shield type must be set first before calling this function.

◆ readPower()

def Function List.readPower (   freqGHz)

This function Read RF Power to the shield.

Parameters
freqGHz(Float) Frequency in GHz where user want to measure.
Returns
[Float Array] RF Power reading in dBm depending on what type of shield.
Note
Shield type must be set first before calling this function.

◆ readVoltage()

def Function List.readVoltage (   ADC_Voltages)

This function Read Voltages to the shield.

Parameters
None
Returns
[Float Array] Voltage reading in Volts depending on what type of shield.
Note
Shield type must be set first before calling this function.

◆ setShieldType()

def Function List.setShieldType (   shield_type,
  None 
)

This function set the type of shield.

Parameters
shield_type(Integer) Type of shield
Returns
None
Note
This function must be called first before calling the other functions.